Move documentation to inline comments: GtkTearoffMenuItem

diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index acc4adac8ad8efae92ac57882a1be6a5cb9c2582..1ceddcfe83bba88a85059be4eef0d8912f8146f8 100644 (file)
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -88,6 +88,7 @@ gtkseparatortoolitem.sgml
 gtksettings.sgml
 gtkstatusbar.sgml
 gtkstyle.sgml
+gtktearoffmenuitem.sgml
 gtktesting.sgml
 gtktextiter.sgml
 gtktexttag.sgml

diff --git a/docs/reference/gtk/tmpl/gtktearoffmenuitem.sgml b/docs/reference/gtk/tmpl/gtktearoffmenuitem.sgml
deleted file mode 100644 (file)
index 450c4aa..0000000
--- a/docs/reference/gtk/tmpl/gtktearoffmenuitem.sgml
+++ /dev/null
@@ -1,60 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkTearoffMenuItem
-
-<!-- ##### SECTION Short_Description ##### -->
-A menu item used to tear off and reattach its menu
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-A #GtkTearoffMenuItem is a special #GtkMenuItem which is used to
-tear off and reattach its menu.
-</para>
-
-<para>
-When its menu is shown normally, the #GtkTearoffMenuItem is drawn as a 
-dotted line indicating that the menu can be torn off.  Activating it 
-causes its menu to be torn off and displayed in its own window 
-as a tearoff menu.
-</para>
-
-<para>
-When its menu is shown as a tearoff menu, the #GtkTearoffMenuItem is drawn
-as a dotted line which has a left pointing arrow graphic indicating that
-the tearoff menu can be reattached.  Activating it will erase the tearoff 
-menu window.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-<variablelist>
-
-<varlistentry>
-<term>#GtkMenu</term>
-<listitem><para>for further discussion of menus in GTK.</para></listitem>
-</varlistentry>
-
-</variablelist>
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkTearoffMenuItem ##### -->
-<para>
-The #GtkTearoffMenuItem-struct struct contains private data only, and
-should be accessed using the functions below.
-</para>
-
-
-<!-- ##### FUNCTION gtk_tearoff_menu_item_new ##### -->
-<para>
-Creates a new #GtkTearoffMenuItem.
-</para>
-
-@void: 
-@Returns: a new #GtkTearoffMenuItem.
-
-

diff --git a/gtk/gtktearoffmenuitem.c b/gtk/gtktearoffmenuitem.c
index f7fa89cd3995a8a237437fde325eeb2c346f8e10..bf3a37c766db5a27e75160a58c530411b1d0b489 100644 (file)
--- a/gtk/gtktearoffmenuitem.c
+++ b/gtk/gtktearoffmenuitem.c
@@ -31,6 +31,28 @@
 #include "gtktearoffmenuitem.h"
 #include "gtkintl.h"
 
+
+/**
+ * SECTION:gtktearoffmenuitem
+ * @Short_description: A menu item used to tear off and reattach its menu
+ * @Title: GtkTearoffMenuItem
+ * @See_also: #GtkMenu
+ *
+ * A #GtkTearoffMenuItem is a special #GtkMenuItem which is used to
+ * tear off and reattach its menu.
+ *
+ * When its menu is shown normally, the #GtkTearoffMenuItem is drawn as a
+ * dotted line indicating that the menu can be torn off.  Activating it
+ * causes its menu to be torn off and displayed in its own window
+ * as a tearoff menu.
+ *
+ * When its menu is shown as a tearoff menu, the #GtkTearoffMenuItem is drawn
+ * as a dotted line which has a left pointing arrow graphic indicating that
+ * the tearoff menu can be reattached.  Activating it will erase the tearoff
+ * menu window.
+ */
+
+
 #define ARROW_SIZE 10
 #define TEAR_LENGTH 5
 #define BORDER_SPACING  3
@@ -54,6 +76,13 @@ static void gtk_tearoff_menu_item_parent_set           (GtkWidget      *widget,
 
 G_DEFINE_TYPE (GtkTearoffMenuItem, gtk_tearoff_menu_item, GTK_TYPE_MENU_ITEM)
 
+/**
+ * gtk_tearoff_menu_item_new:
+ *
+ * Creates a new #GtkTearoffMenuItem.
+ *
+ * Returns: a new #GtkTearoffMenuItem.
+ */
 GtkWidget*
 gtk_tearoff_menu_item_new (void)
 {